solver.datamodel.preferences

class ansys.fluent.core.datamodel_231.preferences.Root

Bases: PyMenu

Singleton Root.

Classes:

Appearance	Singleton Appearance.
GPUApp	Singleton GPUApp.
General	Singleton General.
Graphics	Singleton Graphics.
MatProApp	Singleton MatProApp.
MeshingWorkflow	Singleton MeshingWorkflow.
Navigation	Singleton Navigation.
ParametricStudy	Singleton ParametricStudy.
Simulation	Singleton Simulation.
TurboWorkflow	Singleton TurboWorkflow.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Appearance

Bases: PyMenu

Singleton Appearance.

Classes:

AnsysLogo	Singleton AnsysLogo.
ApplicationFontSize	Parameter ApplicationFontSize of value type int.
AxisTriad	Parameter AxisTriad of value type bool.
Charts	Singleton Charts.
ColorTheme	Parameter ColorTheme of value type str.
Completer	Parameter Completer of value type bool.
CustomTitleBar	Parameter CustomTitleBar of value type bool.
DefaultView	Parameter DefaultView of value type str.
GraphicsBackgroundColor1	Parameter GraphicsBackgroundColor1 of value type str.
GraphicsBackgroundColor2	Parameter GraphicsBackgroundColor2 of value type str.
GraphicsBackgroundStyle	Parameter GraphicsBackgroundStyle of value type str.
GraphicsColorTheme	Parameter GraphicsColorTheme of value type str.
GraphicsDefaultManualFaceColor	Parameter GraphicsDefaultManualFaceColor of value type str.
GraphicsDefaultManualNodeColor	Parameter GraphicsDefaultManualNodeColor of value type str.
GraphicsEdgeColor	Parameter GraphicsEdgeColor of value type str.
GraphicsForegroundColor	Parameter GraphicsForegroundColor of value type str.
GraphicsPartitionBoundaryColor	Parameter GraphicsPartitionBoundaryColor of value type str.
GraphicsSurfaceColor	Parameter GraphicsSurfaceColor of value type str.
GraphicsTitleWindowFramecolor	Parameter GraphicsTitleWindowFramecolor of value type str.
GraphicsView	Parameter GraphicsView of value type str.
GraphicsWallFaceColor	Parameter GraphicsWallFaceColor of value type str.
GroupByTreeView	Parameter GroupByTreeView of value type str.
ModelColorScheme	Parameter ModelColorScheme of value type str.
NumberOfFilesRecentlyUsed	Parameter NumberOfFilesRecentlyUsed of value type int.
NumberOfPastelColors	Parameter NumberOfPastelColors of value type str.
PastelColorSaturation	Parameter PastelColorSaturation of value type float.
PastelColorValue	Parameter PastelColorValue of value type float.
QuickPropertyView	Parameter QuickPropertyView of value type bool.
Ruler	Parameter Ruler of value type bool.
Selections	Singleton Selections.
ShowEnabledModels	Parameter ShowEnabledModels of value type bool.
ShowInterfaceChildrenZone	Parameter ShowInterfaceChildrenZone of value type bool.
ShowModelEdges	Parameter ShowModelEdges of value type bool.
SolutionModeEdgeColorInMeshingMode	Parameter SolutionModeEdgeColorInMeshingMode of value type bool.
SurfaceEmissivity	Parameter SurfaceEmissivity of value type float.
SurfaceSpecularity	Parameter SurfaceSpecularity of value type float.
SurfaceSpecularityForContours	Parameter SurfaceSpecularityForContours of value type float.
Titles	Parameter Titles of value type bool.
TitlesBorderOffset	Parameter TitlesBorderOffset of value type float.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AnsysLogo

Bases: PyMenu

Singleton AnsysLogo.

Classes:

Color	Parameter Color of value type str.
Visible	Parameter Visible of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Color

Bases: PyTextual

Parameter Color of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Visible

Bases: PyParameter

Parameter Visible of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ApplicationFontSize

Bases: PyNumerical

Parameter ApplicationFontSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AxisTriad

Bases: PyParameter

Parameter AxisTriad of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Charts

Bases: PyMenu

Singleton Charts.

Classes:

CurveColors	Parameter CurveColors of value type str.
EnableOpenGLForModernPlots	Parameter EnableOpenGLForModernPlots of value type bool.
Font	Singleton Font.
LegendAlignment	Parameter LegendAlignment of value type str.
LegendVisibility	Parameter LegendVisibility of value type bool.
ModernPlotsEnabled	Parameter ModernPlotsEnabled of value type bool.
ModernPlotsPointsThreshold	Parameter ModernPlotsPointsThreshold of value type bool.
PlotsBehavior	Parameter PlotsBehavior of value type str.
PrintPlotData	Parameter PrintPlotData of value type bool.
PrintResidualsData	Parameter PrintResidualsData of value type int.
TextColor	Singleton TextColor.
Threshold	Parameter Threshold of value type int.
TooltipInterpolation	Parameter TooltipInterpolation of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class CurveColors

Bases: PyTextual

Parameter CurveColors of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EnableOpenGLForModernPlots

Bases: PyParameter

Parameter EnableOpenGLForModernPlots of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Font

Bases: PyMenu

Singleton Font.

Classes:

Axes	Parameter Axes of value type str.
AxesTitles	Parameter AxesTitles of value type str.
Legend	Parameter Legend of value type str.
Title	Parameter Title of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Axes

Bases: PyTextual

Parameter Axes of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AxesTitles

Bases: PyTextual

Parameter AxesTitles of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Legend

Bases: PyTextual

Parameter Legend of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Title

Bases: PyTextual

Parameter Title of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LegendAlignment

Bases: PyTextual

Parameter LegendAlignment of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LegendVisibility

Bases: PyParameter

Parameter LegendVisibility of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ModernPlotsEnabled

Bases: PyParameter

Parameter ModernPlotsEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ModernPlotsPointsThreshold

Bases: PyParameter

Parameter ModernPlotsPointsThreshold of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PlotsBehavior

Bases: PyTextual

Parameter PlotsBehavior of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PrintPlotData

Bases: PyParameter

Parameter PrintPlotData of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PrintResidualsData

Bases: PyNumerical

Parameter PrintResidualsData of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextColor

Bases: PyMenu

Singleton TextColor.

Classes:

Axes	Parameter Axes of value type str.
AxesTitles	Parameter AxesTitles of value type str.
Legend	Parameter Legend of value type str.
Title	Parameter Title of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Axes

Bases: PyTextual

Parameter Axes of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AxesTitles

Bases: PyTextual

Parameter AxesTitles of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Legend

Bases: PyTextual

Parameter Legend of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Title

Bases: PyTextual

Parameter Title of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Threshold

Bases: PyNumerical

Parameter Threshold of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TooltipInterpolation

Bases: PyParameter

Parameter TooltipInterpolation of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ColorTheme

Bases: PyTextual

Parameter ColorTheme of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Completer

Bases: PyParameter

Parameter Completer of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class CustomTitleBar

Bases: PyParameter

Parameter CustomTitleBar of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DefaultView

Bases: PyTextual

Parameter DefaultView of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsBackgroundColor1

Bases: PyTextual

Parameter GraphicsBackgroundColor1 of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsBackgroundColor2

Bases: PyTextual

Parameter GraphicsBackgroundColor2 of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsBackgroundStyle

Bases: PyTextual

Parameter GraphicsBackgroundStyle of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsColorTheme

Bases: PyTextual

Parameter GraphicsColorTheme of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsDefaultManualFaceColor

Bases: PyTextual

Parameter GraphicsDefaultManualFaceColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsDefaultManualNodeColor

Bases: PyTextual

Parameter GraphicsDefaultManualNodeColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsEdgeColor

Bases: PyTextual

Parameter GraphicsEdgeColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsForegroundColor

Bases: PyTextual

Parameter GraphicsForegroundColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsPartitionBoundaryColor

Bases: PyTextual

Parameter GraphicsPartitionBoundaryColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsSurfaceColor

Bases: PyTextual

Parameter GraphicsSurfaceColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsTitleWindowFramecolor

Bases: PyTextual

Parameter GraphicsTitleWindowFramecolor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsView

Bases: PyTextual

Parameter GraphicsView of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsWallFaceColor

Bases: PyTextual

Parameter GraphicsWallFaceColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GroupByTreeView

Bases: PyTextual

Parameter GroupByTreeView of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ModelColorScheme

Bases: PyTextual

Parameter ModelColorScheme of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class NumberOfFilesRecentlyUsed

Bases: PyNumerical

Parameter NumberOfFilesRecentlyUsed of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class NumberOfPastelColors

Bases: PyTextual

Parameter NumberOfPastelColors of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PastelColorSaturation

Bases: PyNumerical

Parameter PastelColorSaturation of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PastelColorValue

Bases: PyNumerical

Parameter PastelColorValue of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class QuickPropertyView

Bases: PyParameter

Parameter QuickPropertyView of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Ruler

Bases: PyParameter

Parameter Ruler of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Selections

Bases: PyMenu

Singleton Selections.

Classes:

GeneralDisplacement	Parameter GeneralDisplacement of value type int.
HighlightEdgeColor	Parameter HighlightEdgeColor of value type str.
HighlightEdgeWeight	Parameter HighlightEdgeWeight of value type int.
HighlightFaceColor	Parameter HighlightFaceColor of value type str.
HighlightGloss	Parameter HighlightGloss of value type float.
HighlightSpecularComponent	Parameter HighlightSpecularComponent of value type str.
HighlightTransparency	Parameter HighlightTransparency of value type float.
MouseHoverProbeValuesEnabled	Parameter MouseHoverProbeValuesEnabled of value type bool.
MouseOverHighlightEnabled	Parameter MouseOverHighlightEnabled of value type bool.
ProbeTooltipHideDelayTimer	Parameter ProbeTooltipHideDelayTimer of value type int.
ProbeTooltipShowDelayTimer	Parameter ProbeTooltipShowDelayTimer of value type int.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class GeneralDisplacement

Bases: PyNumerical

Parameter GeneralDisplacement of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HighlightEdgeColor

Bases: PyTextual

Parameter HighlightEdgeColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HighlightEdgeWeight

Bases: PyNumerical

Parameter HighlightEdgeWeight of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HighlightFaceColor

Bases: PyTextual

Parameter HighlightFaceColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HighlightGloss

Bases: PyNumerical

Parameter HighlightGloss of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HighlightSpecularComponent

Bases: PyTextual

Parameter HighlightSpecularComponent of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HighlightTransparency

Bases: PyNumerical

Parameter HighlightTransparency of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MouseHoverProbeValuesEnabled

Bases: PyParameter

Parameter MouseHoverProbeValuesEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MouseOverHighlightEnabled

Bases: PyParameter

Parameter MouseOverHighlightEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ProbeTooltipHideDelayTimer

Bases: PyNumerical

Parameter ProbeTooltipHideDelayTimer of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ProbeTooltipShowDelayTimer

Bases: PyNumerical

Parameter ProbeTooltipShowDelayTimer of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowEnabledModels

Bases: PyParameter

Parameter ShowEnabledModels of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowInterfaceChildrenZone

Bases: PyParameter

Parameter ShowInterfaceChildrenZone of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowModelEdges

Bases: PyParameter

Parameter ShowModelEdges of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SolutionModeEdgeColorInMeshingMode

Bases: PyParameter

Parameter SolutionModeEdgeColorInMeshingMode of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SurfaceEmissivity

Bases: PyNumerical

Parameter SurfaceEmissivity of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SurfaceSpecularity

Bases: PyNumerical

Parameter SurfaceSpecularity of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SurfaceSpecularityForContours

Bases: PyNumerical

Parameter SurfaceSpecularityForContours of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Titles

Bases: PyParameter

Parameter Titles of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TitlesBorderOffset

Bases: PyNumerical

Parameter TitlesBorderOffset of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GPUApp

Bases: PyMenu

Singleton GPUApp.

Classes:

AlphaFeatures

Parameter AlphaFeatures of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AlphaFeatures

Bases: PyParameter

Parameter AlphaFeatures of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class General

Bases: PyMenu

Singleton General.

Classes:

AdvancedPartition	Parameter AdvancedPartition of value type bool.
AutomaticTranscript	Parameter AutomaticTranscript of value type bool.
DefaultIOFormat	Parameter DefaultIOFormat of value type str.
DockEditor	Parameter DockEditor of value type bool.
EnableParametricStudy	Parameter EnableParametricStudy of value type bool.
FlowModel	Parameter FlowModel of value type str.
IdleTimeout	Parameter IdleTimeout of value type int.
InitialPhysicsVolumeDefinitions	Parameter InitialPhysicsVolumeDefinitions of value type str.
KeyBehavioralChangesMessage	Parameter KeyBehavioralChangesMessage of value type bool.
LaplaceAutoPartitionDefault	Parameter LaplaceAutoPartitionDefault of value type bool.
QAServiceMessage	Parameter QAServiceMessage of value type bool.
UTLCreatePhysicsOnModeChange	Parameter UTLCreatePhysicsOnModeChange of value type bool.
UTLMode	Parameter UTLMode of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AdvancedPartition

Bases: PyParameter

Parameter AdvancedPartition of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AutomaticTranscript

Bases: PyParameter

Parameter AutomaticTranscript of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DefaultIOFormat

Bases: PyTextual

Parameter DefaultIOFormat of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DockEditor

Bases: PyParameter

Parameter DockEditor of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EnableParametricStudy

Bases: PyParameter

Parameter EnableParametricStudy of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class FlowModel

Bases: PyTextual

Parameter FlowModel of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class IdleTimeout

Bases: PyNumerical

Parameter IdleTimeout of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class InitialPhysicsVolumeDefinitions

Bases: PyTextual

Parameter InitialPhysicsVolumeDefinitions of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class KeyBehavioralChangesMessage

Bases: PyParameter

Parameter KeyBehavioralChangesMessage of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LaplaceAutoPartitionDefault

Bases: PyParameter

Parameter LaplaceAutoPartitionDefault of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class QAServiceMessage

Bases: PyParameter

Parameter QAServiceMessage of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class UTLCreatePhysicsOnModeChange

Bases: PyParameter

Parameter UTLCreatePhysicsOnModeChange of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class UTLMode

Bases: PyParameter

Parameter UTLMode of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Graphics

Bases: PyMenu

Singleton Graphics.

Classes:

AnimationOption	Parameter AnimationOption of value type str.
BoundaryMarkers	Singleton BoundaryMarkers.
ColormapSettings	Singleton ColormapSettings.
DoubleBuffering	Parameter DoubleBuffering of value type bool.
EmbeddedWindows	Singleton EmbeddedWindows.
EnableNonObjectBasedWorkflow	Parameter EnableNonObjectBasedWorkflow of value type bool.
EventPollInterval	Parameter EventPollInterval of value type int.
EventPollTimeout	Parameter EventPollTimeout of value type int.
ExportVideoSettings	Singleton ExportVideoSettings.
ForceKeyFrameAnimationMarkersToOff	Parameter ForceKeyFrameAnimationMarkersToOff of value type bool.
GraphicsEffects	Singleton GraphicsEffects.
GraphicsWindowLineWidth	Parameter GraphicsWindowLineWidth of value type str.
GraphicsWindowPointSymbol	Parameter GraphicsWindowPointSymbol of value type str.
HardcopySettings	Singleton HardcopySettings.
HiddenSurfaceRemovalMethod	Parameter HiddenSurfaceRemovalMethod of value type str.
HigherResolutionGraphicsWindowLineWidth	Parameter HigherResolutionGraphicsWindowLineWidth of value type float.
Lighting	Singleton Lighting.
LowerResolutionGraphicsWindowLineWidth	Parameter LowerResolutionGraphicsWindowLineWidth of value type float.
ManageHoopsMemory	Singleton ManageHoopsMemory.
MarkerDrawingMode	Parameter MarkerDrawingMode of value type str.
MaterialEffects	Singleton MaterialEffects.
MaxGraphicsTextSize	Parameter MaxGraphicsTextSize of value type int.
MeshingMode	Singleton MeshingMode.
MinGraphicsTextSize	Parameter MinGraphicsTextSize of value type int.
Performance	Singleton Performance.
PlotLegendMargin	Parameter PlotLegendMargin of value type float.
PointToolSize	Parameter PointToolSize of value type float.
RemovePartitionLines	Parameter RemovePartitionLines of value type bool.
RemovePartitionLinesTolerance	Parameter RemovePartitionLinesTolerance of value type float.
RotationCenterpointVisible	Parameter RotationCenterpointVisible of value type bool.
ScrollWheelEventEndTimer	Parameter ScrollWheelEventEndTimer of value type int.
SetCameraNormalToSurfaceIncrements	Parameter SetCameraNormalToSurfaceIncrements of value type int.
ShowHiddenLines	Parameter ShowHiddenLines of value type bool.
ShowHiddenSurfaces	Parameter ShowHiddenSurfaces of value type bool.
SwitchToOpenGLForRemoteVisualization	Parameter SwitchToOpenGLForRemoteVisualization of value type bool.
TestUseExternalFunction	Parameter TestUseExternalFunction of value type str.
TextWindowLineWidth	Parameter TextWindowLineWidth of value type str.
Transparency	Singleton Transparency.
VectorSettings	Singleton VectorSettings.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AnimationOption

Bases: PyTextual

Parameter AnimationOption of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class BoundaryMarkers

Bases: PyMenu

Singleton BoundaryMarkers.

Classes:

ColorOption	Parameter ColorOption of value type str.
Enabled	Parameter Enabled of value type bool.
ExcludeFromBounding	Parameter ExcludeFromBounding of value type bool.
InletColor	Parameter InletColor of value type str.
MarkerFraction	Parameter MarkerFraction of value type float.
MarkerSizeLimitingScaleMultiplier	Parameter MarkerSizeLimitingScaleMultiplier of value type float.
MarkersLimit	Parameter MarkersLimit of value type int.
OutletColor	Parameter OutletColor of value type str.
ScaleMarker	Parameter ScaleMarker of value type float.
ShowInletMarkers	Parameter ShowInletMarkers of value type bool.
ShowOutletMarkers	Parameter ShowOutletMarkers of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class ColorOption

Bases: PyTextual

Parameter ColorOption of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Enabled

Bases: PyParameter

Parameter Enabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ExcludeFromBounding

Bases: PyParameter

Parameter ExcludeFromBounding of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class InletColor

Bases: PyTextual

Parameter InletColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarkerFraction

Bases: PyNumerical

Parameter MarkerFraction of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarkerSizeLimitingScaleMultiplier

Bases: PyNumerical

Parameter MarkerSizeLimitingScaleMultiplier of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarkersLimit

Bases: PyNumerical

Parameter MarkersLimit of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class OutletColor

Bases: PyTextual

Parameter OutletColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ScaleMarker

Bases: PyNumerical

Parameter ScaleMarker of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowInletMarkers

Bases: PyParameter

Parameter ShowInletMarkers of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowOutletMarkers

Bases: PyParameter

Parameter ShowOutletMarkers of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ColormapSettings

Bases: PyMenu

Singleton ColormapSettings.

Classes:

Alignment	Parameter Alignment of value type str.
AspectRatioWhenHorizontal	Parameter AspectRatioWhenHorizontal of value type float.
AspectRatioWhenVertical	Parameter AspectRatioWhenVertical of value type float.
AutoRefitOnResize	Parameter AutoRefitOnResize of value type bool.
AutomaticResize	Parameter AutomaticResize of value type bool.
BorderStyle	Parameter BorderStyle of value type str.
Colormap	Parameter Colormap of value type str.
IsolinesPositionOffset	Parameter IsolinesPositionOffset of value type float.
Labels	Parameter Labels of value type bool.
Levels	Parameter Levels of value type int.
LogScale	Parameter LogScale of value type bool.
MajorLengthToScreenRatioWhenHorizontal	Parameter MajorLengthToScreenRatioWhenHorizontal of value type float.
MajorLengthToScreenRatioWhenVertical	Parameter MajorLengthToScreenRatioWhenVertical of value type float.
MarginFromEdgeToScreenRatio	Parameter MarginFromEdgeToScreenRatio of value type float.
MaxSizeScaleFactor	Parameter MaxSizeScaleFactor of value type float.
MinSizeScaleFactor	Parameter MinSizeScaleFactor of value type float.
NumberFormatPrecision	Parameter NumberFormatPrecision of value type int.
NumberFormatType	Parameter NumberFormatType of value type str.
PreserveAspectRatioForHardcopy	Parameter PreserveAspectRatioForHardcopy of value type bool.
ShowColormap	Parameter ShowColormap of value type bool.
SkipValue	Parameter SkipValue of value type int.
TextBehavior	Parameter TextBehavior of value type str.
TextFontAutomaticHorizontalSize	Parameter TextFontAutomaticHorizontalSize of value type float.
TextFontAutomaticSize	Parameter TextFontAutomaticSize of value type float.
TextFontAutomaticUnits	Parameter TextFontAutomaticUnits of value type str.
TextFontAutomaticVerticalSize	Parameter TextFontAutomaticVerticalSize of value type float.
TextFontFixedHorizontalSize	Parameter TextFontFixedHorizontalSize of value type int.
TextFontFixedSize	Parameter TextFontFixedSize of value type int.
TextFontFixedUnits	Parameter TextFontFixedUnits of value type str.
TextFontFixedVerticalSize	Parameter TextFontFixedVerticalSize of value type int.
TextFontName	Parameter TextFontName of value type str.
TextTruncationLimitForHorizontalColormaps	Parameter TextTruncationLimitForHorizontalColormaps of value type int.
TextTruncationLimitForVerticalColormaps	Parameter TextTruncationLimitForVerticalColormaps of value type int.
Type	Parameter Type of value type str.
UseNoSubWindows	Parameter UseNoSubWindows of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Alignment

Bases: PyTextual

Parameter Alignment of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AspectRatioWhenHorizontal

Bases: PyNumerical

Parameter AspectRatioWhenHorizontal of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AspectRatioWhenVertical

Bases: PyNumerical

Parameter AspectRatioWhenVertical of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AutoRefitOnResize

Bases: PyParameter

Parameter AutoRefitOnResize of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AutomaticResize

Bases: PyParameter

Parameter AutomaticResize of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class BorderStyle

Bases: PyTextual

Parameter BorderStyle of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Colormap

Bases: PyTextual

Parameter Colormap of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class IsolinesPositionOffset

Bases: PyNumerical

Parameter IsolinesPositionOffset of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Labels

Bases: PyParameter

Parameter Labels of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Levels

Bases: PyNumerical

Parameter Levels of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LogScale

Bases: PyParameter

Parameter LogScale of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MajorLengthToScreenRatioWhenHorizontal

Bases: PyNumerical

Parameter MajorLengthToScreenRatioWhenHorizontal of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MajorLengthToScreenRatioWhenVertical

Bases: PyNumerical

Parameter MajorLengthToScreenRatioWhenVertical of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarginFromEdgeToScreenRatio

Bases: PyNumerical

Parameter MarginFromEdgeToScreenRatio of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MaxSizeScaleFactor

Bases: PyNumerical

Parameter MaxSizeScaleFactor of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MinSizeScaleFactor

Bases: PyNumerical

Parameter MinSizeScaleFactor of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class NumberFormatPrecision

Bases: PyNumerical

Parameter NumberFormatPrecision of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class NumberFormatType

Bases: PyTextual

Parameter NumberFormatType of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PreserveAspectRatioForHardcopy

Bases: PyParameter

Parameter PreserveAspectRatioForHardcopy of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowColormap

Bases: PyParameter

Parameter ShowColormap of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SkipValue

Bases: PyNumerical

Parameter SkipValue of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextBehavior

Bases: PyTextual

Parameter TextBehavior of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontAutomaticHorizontalSize

Bases: PyNumerical

Parameter TextFontAutomaticHorizontalSize of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontAutomaticSize

Bases: PyNumerical

Parameter TextFontAutomaticSize of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontAutomaticUnits

Bases: PyTextual

Parameter TextFontAutomaticUnits of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontAutomaticVerticalSize

Bases: PyNumerical

Parameter TextFontAutomaticVerticalSize of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontFixedHorizontalSize

Bases: PyNumerical

Parameter TextFontFixedHorizontalSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontFixedSize

Bases: PyNumerical

Parameter TextFontFixedSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontFixedUnits

Bases: PyTextual

Parameter TextFontFixedUnits of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontFixedVerticalSize

Bases: PyNumerical

Parameter TextFontFixedVerticalSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontName

Bases: PyTextual

Parameter TextFontName of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextTruncationLimitForHorizontalColormaps

Bases: PyNumerical

Parameter TextTruncationLimitForHorizontalColormaps of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextTruncationLimitForVerticalColormaps

Bases: PyNumerical

Parameter TextTruncationLimitForVerticalColormaps of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Type

Bases: PyTextual

Parameter Type of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class UseNoSubWindows

Bases: PyParameter

Parameter UseNoSubWindows of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DoubleBuffering

Bases: PyParameter

Parameter DoubleBuffering of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EmbeddedWindows

Bases: PyMenu

Singleton EmbeddedWindows.

Classes:

DefaultEmbeddedMeshWindowsView	Parameter DefaultEmbeddedMeshWindowsView of value type bool.
DefaultEmbeddedWindowsView	Parameter DefaultEmbeddedWindowsView of value type bool.
SaveEmbeddedWindowLayout	Parameter SaveEmbeddedWindowLayout of value type bool.
ShowBorderForEmbeddedWindow	Parameter ShowBorderForEmbeddedWindow of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class DefaultEmbeddedMeshWindowsView

Bases: PyParameter

Parameter DefaultEmbeddedMeshWindowsView of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DefaultEmbeddedWindowsView

Bases: PyParameter

Parameter DefaultEmbeddedWindowsView of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SaveEmbeddedWindowLayout

Bases: PyParameter

Parameter SaveEmbeddedWindowLayout of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowBorderForEmbeddedWindow

Bases: PyParameter

Parameter ShowBorderForEmbeddedWindow of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EnableNonObjectBasedWorkflow

Bases: PyParameter

Parameter EnableNonObjectBasedWorkflow of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EventPollInterval

Bases: PyNumerical

Parameter EventPollInterval of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EventPollTimeout

Bases: PyNumerical

Parameter EventPollTimeout of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ExportVideoSettings

Bases: PyMenu

Singleton ExportVideoSettings.

Classes:

AdvancedVideoQualityOptions	Singleton AdvancedVideoQualityOptions.
VideoFPS	Parameter VideoFPS of value type int.
VideoFormat	Parameter VideoFormat of value type str.
VideoQuality	Parameter VideoQuality of value type str.
VideoResoutionX	Parameter VideoResoutionX of value type int.
VideoResoutionY	Parameter VideoResoutionY of value type int.
VideoScale	Parameter VideoScale of value type str.
VideoSmoothScaling	Parameter VideoSmoothScaling of value type bool.
VideoUseFrameResolution	Parameter VideoUseFrameResolution of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AdvancedVideoQualityOptions

Bases: PyMenu

Singleton AdvancedVideoQualityOptions.

Classes:

BitRateQuality	Parameter BitRateQuality of value type str.
Bitrate	Parameter Bitrate of value type int.
CompressionMethod	Parameter CompressionMethod of value type str.
EnableH264	Parameter EnableH264 of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class BitRateQuality

Bases: PyTextual

Parameter BitRateQuality of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Bitrate

Bases: PyNumerical

Parameter Bitrate of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class CompressionMethod

Bases: PyTextual

Parameter CompressionMethod of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EnableH264

Bases: PyParameter

Parameter EnableH264 of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoFPS

Bases: PyNumerical

Parameter VideoFPS of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoFormat

Bases: PyTextual

Parameter VideoFormat of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoQuality

Bases: PyTextual

Parameter VideoQuality of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoResoutionX

Bases: PyNumerical

Parameter VideoResoutionX of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoResoutionY

Bases: PyNumerical

Parameter VideoResoutionY of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoScale

Bases: PyTextual

Parameter VideoScale of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoSmoothScaling

Bases: PyParameter

Parameter VideoSmoothScaling of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoUseFrameResolution

Bases: PyParameter

Parameter VideoUseFrameResolution of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ForceKeyFrameAnimationMarkersToOff

Bases: PyParameter

Parameter ForceKeyFrameAnimationMarkersToOff of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsEffects

Bases: PyMenu

Singleton GraphicsEffects.

Classes:

AmbientOcclusionEnabled	Parameter AmbientOcclusionEnabled of value type bool.
AmbientOcclusionQuality	Parameter AmbientOcclusionQuality of value type str.
AmbientOcclusionStrength	Parameter AmbientOcclusionStrength of value type int.
AntiAliasing	Parameter AntiAliasing of value type bool.
BloomBlur	Parameter BloomBlur of value type int.
BloomEnabled	Parameter BloomEnabled of value type bool.
BloomStrength	Parameter BloomStrength of value type int.
GridColor	Parameter GridColor of value type str.
GridPlaneCount	Parameter GridPlaneCount of value type int.
GridPlaneEnabled	Parameter GridPlaneEnabled of value type bool.
GridPlaneOffset	Parameter GridPlaneOffset of value type int.
GridPlaneSizeFactor	Parameter GridPlaneSizeFactor of value type int.
PlaneDirection	Parameter PlaneDirection of value type str.
ReflectionsEnabled	Parameter ReflectionsEnabled of value type bool.
ShadowMapEnabled	Parameter ShadowMapEnabled of value type bool.
ShowEdgeReflections	Parameter ShowEdgeReflections of value type bool.
ShowMarkerReflections	Parameter ShowMarkerReflections of value type bool.
SimpleShadowsEnabled	Parameter SimpleShadowsEnabled of value type bool.
UpdateAfterMouseRelease	Parameter UpdateAfterMouseRelease of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AmbientOcclusionEnabled

Bases: PyParameter

Parameter AmbientOcclusionEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AmbientOcclusionQuality

Bases: PyTextual

Parameter AmbientOcclusionQuality of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AmbientOcclusionStrength

Bases: PyNumerical

Parameter AmbientOcclusionStrength of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AntiAliasing

Bases: PyParameter

Parameter AntiAliasing of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class BloomBlur

Bases: PyNumerical

Parameter BloomBlur of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class BloomEnabled

Bases: PyParameter

Parameter BloomEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class BloomStrength

Bases: PyNumerical

Parameter BloomStrength of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GridColor

Bases: PyTextual

Parameter GridColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GridPlaneCount

Bases: PyNumerical

Parameter GridPlaneCount of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GridPlaneEnabled

Bases: PyParameter

Parameter GridPlaneEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GridPlaneOffset

Bases: PyNumerical

Parameter GridPlaneOffset of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GridPlaneSizeFactor

Bases: PyNumerical

Parameter GridPlaneSizeFactor of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PlaneDirection

Bases: PyTextual

Parameter PlaneDirection of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ReflectionsEnabled

Bases: PyParameter

Parameter ReflectionsEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShadowMapEnabled

Bases: PyParameter

Parameter ShadowMapEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowEdgeReflections

Bases: PyParameter

Parameter ShowEdgeReflections of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowMarkerReflections

Bases: PyParameter

Parameter ShowMarkerReflections of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SimpleShadowsEnabled

Bases: PyParameter

Parameter SimpleShadowsEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class UpdateAfterMouseRelease

Bases: PyParameter

Parameter UpdateAfterMouseRelease of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsWindowLineWidth

Bases: PyTextual

Parameter GraphicsWindowLineWidth of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsWindowPointSymbol

Bases: PyTextual

Parameter GraphicsWindowPointSymbol of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HardcopySettings

Bases: PyMenu

Singleton HardcopySettings.

Classes:

ExportEdgesForAVZ	Parameter ExportEdgesForAVZ of value type bool.
HardcopyDriver	Parameter HardcopyDriver of value type str.
HardcopyLineWidth	Parameter HardcopyLineWidth of value type int.
HardwareImageAccel	Parameter HardwareImageAccel of value type bool.
PostScriptPermissionOverride	Parameter PostScriptPermissionOverride of value type bool.
SaveEmbeddedHardcopiesSeparately	Parameter SaveEmbeddedHardcopiesSeparately of value type bool.
SaveEmbeddedWindowsInHardcopy	Parameter SaveEmbeddedWindowsInHardcopy of value type bool.
TransparentEmbeddedWindows	Parameter TransparentEmbeddedWindows of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class ExportEdgesForAVZ

Bases: PyParameter

Parameter ExportEdgesForAVZ of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HardcopyDriver

Bases: PyTextual

Parameter HardcopyDriver of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HardcopyLineWidth

Bases: PyNumerical

Parameter HardcopyLineWidth of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HardwareImageAccel

Bases: PyParameter

Parameter HardwareImageAccel of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PostScriptPermissionOverride

Bases: PyParameter

Parameter PostScriptPermissionOverride of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SaveEmbeddedHardcopiesSeparately

Bases: PyParameter

Parameter SaveEmbeddedHardcopiesSeparately of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SaveEmbeddedWindowsInHardcopy

Bases: PyParameter

Parameter SaveEmbeddedWindowsInHardcopy of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TransparentEmbeddedWindows

Bases: PyParameter

Parameter TransparentEmbeddedWindows of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HiddenSurfaceRemovalMethod

Bases: PyTextual

Parameter HiddenSurfaceRemovalMethod of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HigherResolutionGraphicsWindowLineWidth

Bases: PyNumerical

Parameter HigherResolutionGraphicsWindowLineWidth of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Lighting

Bases: PyMenu

Singleton Lighting.

Classes:

AmbientLightIntensity	Parameter AmbientLightIntensity of value type float.
Headlight	Parameter Headlight of value type str.
HeadlightIntensity	Parameter HeadlightIntensity of value type float.
LightingMethod	Parameter LightingMethod of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AmbientLightIntensity

Bases: PyNumerical

Parameter AmbientLightIntensity of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Headlight

Bases: PyTextual

Parameter Headlight of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HeadlightIntensity

Bases: PyNumerical

Parameter HeadlightIntensity of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LightingMethod

Bases: PyTextual

Parameter LightingMethod of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LowerResolutionGraphicsWindowLineWidth

Bases: PyNumerical

Parameter LowerResolutionGraphicsWindowLineWidth of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ManageHoopsMemory

Bases: PyMenu

Singleton ManageHoopsMemory.

Classes:

Enabled	Parameter Enabled of value type bool.
HSFImportLimit	Parameter HSFImportLimit of value type int.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Enabled

Bases: PyParameter

Parameter Enabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HSFImportLimit

Bases: PyNumerical

Parameter HSFImportLimit of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarkerDrawingMode

Bases: PyTextual

Parameter MarkerDrawingMode of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MaterialEffects

Bases: PyMenu

Singleton MaterialEffects.

Classes:

DecimationFilter	Parameter DecimationFilter of value type str.
ParameterizationSource	Parameter ParameterizationSource of value type str.
TilingStyle	Parameter TilingStyle of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class DecimationFilter

Bases: PyTextual

Parameter DecimationFilter of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ParameterizationSource

Bases: PyTextual

Parameter ParameterizationSource of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TilingStyle

Bases: PyTextual

Parameter TilingStyle of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MaxGraphicsTextSize

Bases: PyNumerical

Parameter MaxGraphicsTextSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MeshingMode

Bases: PyMenu

Singleton MeshingMode.

Classes:

GraphicsWindowDisplayTimeout	Parameter GraphicsWindowDisplayTimeout of value type bool.
GraphicsWindowDisplayTimeoutValue	Parameter GraphicsWindowDisplayTimeoutValue of value type float.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class GraphicsWindowDisplayTimeout

Bases: PyParameter

Parameter GraphicsWindowDisplayTimeout of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsWindowDisplayTimeoutValue

Bases: PyNumerical

Parameter GraphicsWindowDisplayTimeoutValue of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MinGraphicsTextSize

Bases: PyNumerical

Parameter MinGraphicsTextSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Performance

Bases: PyMenu

Singleton Performance.

Classes:

FastDisplayMode	Singleton FastDisplayMode.
MinimumFrameRate	Singleton MinimumFrameRate.
OptimizeFor	Parameter OptimizeFor of value type str.
RatioOfTargetFrameRateToClassifyHeavyGeometry	Parameter RatioOfTargetFrameRateToClassifyHeavyGeometry of value type float.
RatioOfTargetFrameRateToDeclassifyHeavyGeometry	Parameter RatioOfTargetFrameRateToDeclassifyHeavyGeometry of value type float.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class FastDisplayMode

Bases: PyMenu

Singleton FastDisplayMode.

Classes:

Culling	Parameter Culling of value type int.
FacesShown	Parameter FacesShown of value type bool.
MarkersDecimation	Parameter MarkersDecimation of value type float.
NodesShown	Parameter NodesShown of value type bool.
PerimeterEdgesShown	Parameter PerimeterEdgesShown of value type bool.
SilhouetteShown	Parameter SilhouetteShown of value type bool.
Status	Parameter Status of value type str.
Transparency	Parameter Transparency of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Culling

Bases: PyNumerical

Parameter Culling of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class FacesShown

Bases: PyParameter

Parameter FacesShown of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarkersDecimation

Bases: PyNumerical

Parameter MarkersDecimation of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class NodesShown

Bases: PyParameter

Parameter NodesShown of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PerimeterEdgesShown

Bases: PyParameter

Parameter PerimeterEdgesShown of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SilhouetteShown

Bases: PyParameter

Parameter SilhouetteShown of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Status

Bases: PyTextual

Parameter Status of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Transparency

Bases: PyParameter

Parameter Transparency of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MinimumFrameRate

Bases: PyMenu

Singleton MinimumFrameRate.

Classes:

DynamicAdjustment	Parameter DynamicAdjustment of value type bool.
Enabled	Parameter Enabled of value type bool.
FixedCullingValue	Parameter FixedCullingValue of value type int.
MaximumCullingThreshold	Parameter MaximumCullingThreshold of value type int.
MinimumCullingThreshold	Parameter MinimumCullingThreshold of value type int.
TargetFPS	Parameter TargetFPS of value type int.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class DynamicAdjustment

Bases: PyParameter

Parameter DynamicAdjustment of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Enabled

Bases: PyParameter

Parameter Enabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class FixedCullingValue

Bases: PyNumerical

Parameter FixedCullingValue of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MaximumCullingThreshold

Bases: PyNumerical

Parameter MaximumCullingThreshold of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MinimumCullingThreshold

Bases: PyNumerical

Parameter MinimumCullingThreshold of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TargetFPS

Bases: PyNumerical

Parameter TargetFPS of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class OptimizeFor

Bases: PyTextual

Parameter OptimizeFor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RatioOfTargetFrameRateToClassifyHeavyGeometry

Bases: PyNumerical

Parameter RatioOfTargetFrameRateToClassifyHeavyGeometry of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RatioOfTargetFrameRateToDeclassifyHeavyGeometry

Bases: PyNumerical

Parameter RatioOfTargetFrameRateToDeclassifyHeavyGeometry of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PlotLegendMargin

Bases: PyNumerical

Parameter PlotLegendMargin of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PointToolSize

Bases: PyNumerical

Parameter PointToolSize of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RemovePartitionLines

Bases: PyParameter

Parameter RemovePartitionLines of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RemovePartitionLinesTolerance

Bases: PyNumerical

Parameter RemovePartitionLinesTolerance of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RotationCenterpointVisible

Bases: PyParameter

Parameter RotationCenterpointVisible of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ScrollWheelEventEndTimer

Bases: PyNumerical

Parameter ScrollWheelEventEndTimer of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SetCameraNormalToSurfaceIncrements

Bases: PyNumerical

Parameter SetCameraNormalToSurfaceIncrements of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowHiddenLines

Bases: PyParameter

Parameter ShowHiddenLines of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowHiddenSurfaces

Bases: PyParameter

Parameter ShowHiddenSurfaces of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SwitchToOpenGLForRemoteVisualization

Bases: PyParameter

Parameter SwitchToOpenGLForRemoteVisualization of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TestUseExternalFunction

Bases: PyTextual

Parameter TestUseExternalFunction of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextWindowLineWidth

Bases: PyTextual

Parameter TextWindowLineWidth of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Transparency

Bases: PyMenu

Singleton Transparency.

Classes:

AlgorithmForModernDrivers	Parameter AlgorithmForModernDrivers of value type str.
DepthPeelingLayers	Parameter DepthPeelingLayers of value type int.
DepthPeelingPreference	Parameter DepthPeelingPreference of value type str.
QuickMoves	Parameter QuickMoves of value type str.
ZSortOptions	Parameter ZSortOptions of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AlgorithmForModernDrivers

Bases: PyTextual

Parameter AlgorithmForModernDrivers of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DepthPeelingLayers

Bases: PyNumerical

Parameter DepthPeelingLayers of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DepthPeelingPreference

Bases: PyTextual

Parameter DepthPeelingPreference of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class QuickMoves

Bases: PyTextual

Parameter QuickMoves of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ZSortOptions

Bases: PyTextual

Parameter ZSortOptions of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VectorSettings

Bases: PyMenu

Singleton VectorSettings.

Classes:

Arrow3DRadius1Factor	Parameter Arrow3DRadius1Factor of value type float.
Arrow3DRadius2Factor	Parameter Arrow3DRadius2Factor of value type float.
Arrowhead3DRadius1Factor	Parameter Arrowhead3DRadius1Factor of value type float.
LineArrow3DPerpendicularRadius	Parameter LineArrow3DPerpendicularRadius of value type float.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Arrow3DRadius1Factor

Bases: PyNumerical

Parameter Arrow3DRadius1Factor of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Arrow3DRadius2Factor

Bases: PyNumerical

Parameter Arrow3DRadius2Factor of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Arrowhead3DRadius1Factor

Bases: PyNumerical

Parameter Arrowhead3DRadius1Factor of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LineArrow3DPerpendicularRadius

Bases: PyNumerical

Parameter LineArrow3DPerpendicularRadius of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MatProApp

Bases: PyMenu

Singleton MatProApp.

Classes:

BetaFeatures	Parameter BetaFeatures of value type bool.
Focus	Parameter Focus of value type bool.
Warning	Parameter Warning of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class BetaFeatures

Bases: PyParameter

Parameter BetaFeatures of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Focus

Bases: PyParameter

Parameter Focus of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Warning

Bases: PyParameter

Parameter Warning of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MeshingWorkflow

Bases: PyMenu

Singleton MeshingWorkflow.

Classes:

CheckpointingOption	Parameter CheckpointingOption of value type str.
DrawSettings	Singleton DrawSettings.
SaveCheckpointFiles	Parameter SaveCheckpointFiles of value type bool.
TempFolder	Parameter TempFolder of value type str.
TemplatesFolder	Parameter TemplatesFolder of value type str.
Verbosity	Parameter Verbosity of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class CheckpointingOption

Bases: PyTextual

Parameter CheckpointingOption of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DrawSettings

Bases: PyMenu

Singleton DrawSettings.

Classes:

AutoDraw	Parameter AutoDraw of value type str.
FaceZoneLimit	Parameter FaceZoneLimit of value type int.
FacetLimit	Parameter FacetLimit of value type int.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AutoDraw

Bases: PyTextual

Parameter AutoDraw of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class FaceZoneLimit

Bases: PyNumerical

Parameter FaceZoneLimit of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class FacetLimit

Bases: PyNumerical

Parameter FacetLimit of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SaveCheckpointFiles

Bases: PyParameter

Parameter SaveCheckpointFiles of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TempFolder

Bases: PyTextual

Parameter TempFolder of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TemplatesFolder

Bases: PyTextual

Parameter TemplatesFolder of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Verbosity

Bases: PyTextual

Parameter Verbosity of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Navigation

Bases: PyMenu

Singleton Navigation.

Classes:

MouseMapping

Singleton MouseMapping.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class MouseMapping

Bases: PyMenu

Singleton MouseMapping.

Classes:

Additional	Singleton Additional.
Basic	Singleton Basic.
MOUSEMAPTHEME	Parameter MOUSEMAPTHEME of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Additional

Bases: PyMenu

Singleton Additional.

Classes:

CTRLLMBCLICK	Parameter CTRLLMBCLICK of value type str.
CTRLLMBDRAG	Parameter CTRLLMBDRAG of value type str.
CTRLMMBCLICK	Parameter CTRLMMBCLICK of value type str.
CTRLMMBDRAG	Parameter CTRLMMBDRAG of value type str.
CTRLRMBCLICK	Parameter CTRLRMBCLICK of value type str.
CTRLRMBDRAG	Parameter CTRLRMBDRAG of value type str.
MOUSEPROBE	Parameter MOUSEPROBE of value type str.
MOUSEWHEEL	Parameter MOUSEWHEEL of value type str.
MOUSEWHEELSENSITIVITY	Parameter MOUSEWHEELSENSITIVITY of value type float.
REVERSEWHEELDIRECTION	Parameter REVERSEWHEELDIRECTION of value type bool.
SHIFTLMBCLICK	Parameter SHIFTLMBCLICK of value type str.
SHIFTLMBDRAG	Parameter SHIFTLMBDRAG of value type str.
SHIFTMMBCLICK	Parameter SHIFTMMBCLICK of value type str.
SHIFTMMBDRAG	Parameter SHIFTMMBDRAG of value type str.
SHIFTRMBCLICK	Parameter SHIFTRMBCLICK of value type str.
SHIFTRMBDRAG	Parameter SHIFTRMBDRAG of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class CTRLLMBCLICK

Bases: PyTextual

Parameter CTRLLMBCLICK of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class CTRLLMBDRAG

Bases: PyTextual

Parameter CTRLLMBDRAG of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class CTRLMMBCLICK

Bases: PyTextual

Parameter CTRLMMBCLICK of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class CTRLMMBDRAG

Bases: PyTextual

Parameter CTRLMMBDRAG of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class CTRLRMBCLICK

Bases: PyTextual

Parameter CTRLRMBCLICK of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class CTRLRMBDRAG

Bases: PyTextual

Parameter CTRLRMBDRAG of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MOUSEPROBE

Bases: PyTextual

Parameter MOUSEPROBE of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MOUSEWHEEL

Bases: PyTextual

Parameter MOUSEWHEEL of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MOUSEWHEELSENSITIVITY

Bases: PyNumerical

Parameter MOUSEWHEELSENSITIVITY of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class REVERSEWHEELDIRECTION

Bases: PyParameter

Parameter REVERSEWHEELDIRECTION of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SHIFTLMBCLICK

Bases: PyTextual

Parameter SHIFTLMBCLICK of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SHIFTLMBDRAG

Bases: PyTextual

Parameter SHIFTLMBDRAG of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SHIFTMMBCLICK

Bases: PyTextual

Parameter SHIFTMMBCLICK of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SHIFTMMBDRAG

Bases: PyTextual

Parameter SHIFTMMBDRAG of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SHIFTRMBCLICK

Bases: PyTextual

Parameter SHIFTRMBCLICK of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SHIFTRMBDRAG

Bases: PyTextual

Parameter SHIFTRMBDRAG of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Basic

Bases: PyMenu

Singleton Basic.

Classes:

LMB	Parameter LMB of value type str.
LMBCLICK	Parameter LMBCLICK of value type str.
MMB	Parameter MMB of value type str.
MMBCLICK	Parameter MMBCLICK of value type str.
RMB	Parameter RMB of value type str.
RMBCLICK	Parameter RMBCLICK of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class LMB

Bases: PyTextual

Parameter LMB of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LMBCLICK

Bases: PyTextual

Parameter LMBCLICK of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MMB

Bases: PyTextual

Parameter MMB of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MMBCLICK

Bases: PyTextual

Parameter MMBCLICK of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RMB

Bases: PyTextual

Parameter RMB of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RMBCLICK

Bases: PyTextual

Parameter RMBCLICK of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MOUSEMAPTHEME

Bases: PyTextual

Parameter MOUSEMAPTHEME of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ParametricStudy

Bases: PyMenu

Singleton ParametricStudy.

Classes:

LayoutOptions	Singleton LayoutOptions.
UpdateOptions	Singleton UpdateOptions.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class LayoutOptions

Bases: PyMenu

Singleton LayoutOptions.

Classes:

CurrentCaseParameters	Parameter CurrentCaseParameters of value type bool.
ParametricStudyTree	Parameter ParametricStudyTree of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class CurrentCaseParameters

Bases: PyParameter

Parameter CurrentCaseParameters of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ParametricStudyTree

Bases: PyParameter

Parameter ParametricStudyTree of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class UpdateOptions

Bases: PyMenu

Singleton UpdateOptions.

Classes:

AutoRefreshTime	Parameter AutoRefreshTime of value type int.
CaptureSimReportData	Parameter CaptureSimReportData of value type bool.
EnableAutoRefresh	Parameter EnableAutoRefresh of value type bool.
SaveProjectAfterDPUpdate	Parameter SaveProjectAfterDPUpdate of value type bool.
WriteData	Parameter WriteData of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AutoRefreshTime

Bases: PyNumerical

Parameter AutoRefreshTime of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class CaptureSimReportData

Bases: PyParameter

Parameter CaptureSimReportData of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EnableAutoRefresh

Bases: PyParameter

Parameter EnableAutoRefresh of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SaveProjectAfterDPUpdate

Bases: PyParameter

Parameter SaveProjectAfterDPUpdate of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class WriteData

Bases: PyParameter

Parameter WriteData of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Simulation

Bases: PyMenu

Singleton Simulation.

Classes:

FlowModel	Parameter FlowModel of value type str.
LocalResidualScaling	Parameter LocalResidualScaling of value type bool.
ReportDefinitions	Singleton ReportDefinitions.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class FlowModel

Bases: PyTextual

Parameter FlowModel of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LocalResidualScaling

Bases: PyParameter

Parameter LocalResidualScaling of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ReportDefinitions

Bases: PyMenu

Singleton ReportDefinitions.

Classes:

AutomaticPlotFile	Parameter AutomaticPlotFile of value type bool.
ReportPlotHistoryDataSize	Parameter ReportPlotHistoryDataSize of value type int.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AutomaticPlotFile

Bases: PyParameter

Parameter AutomaticPlotFile of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ReportPlotHistoryDataSize

Bases: PyNumerical

Parameter ReportPlotHistoryDataSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TurboWorkflow

Bases: PyMenu

Singleton TurboWorkflow.

Classes:

CellZoneSettings	Singleton CellZoneSettings.
CheckpointingOption	Parameter CheckpointingOption of value type str.
FaceZoneSettings	Singleton FaceZoneSettings.
GraphicsSettings	Singleton GraphicsSettings.
SaveCheckpointFiles	Parameter SaveCheckpointFiles of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class CellZoneSettings

Bases: PyMenu

Singleton CellZoneSettings.

Classes:

CZSearchOrder	Parameter CZSearchOrder of value type str.
Rotating	Parameter Rotating of value type str.
Stationary	Parameter Stationary of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class CZSearchOrder

Bases: PyTextual

Parameter CZSearchOrder of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Rotating

Bases: PyTextual

Parameter Rotating of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Stationary

Bases: PyTextual

Parameter Stationary of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class CheckpointingOption

Bases: PyTextual

Parameter CheckpointingOption of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class FaceZoneSettings

Bases: PyMenu

Singleton FaceZoneSettings.

Classes:

BladeRegion	Parameter BladeRegion of value type str.
FZSearchOrder	Parameter FZSearchOrder of value type str.
HubRegion	Parameter HubRegion of value type str.
InletRegion	Parameter InletRegion of value type str.
InteriorRegion	Parameter InteriorRegion of value type str.
OutletRegion	Parameter OutletRegion of value type str.
Periodic1Region	Parameter Periodic1Region of value type str.
Periodic2Region	Parameter Periodic2Region of value type str.
ShroudRegion	Parameter ShroudRegion of value type str.
SymmetryRegion	Parameter SymmetryRegion of value type str.
Tip1Region	Parameter Tip1Region of value type str.
Tip2Region	Parameter Tip2Region of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class BladeRegion

Bases: PyTextual

Parameter BladeRegion of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class FZSearchOrder

Bases: PyTextual

Parameter FZSearchOrder of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HubRegion

Bases: PyTextual

Parameter HubRegion of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class InletRegion

Bases: PyTextual

Parameter InletRegion of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class InteriorRegion

Bases: PyTextual

Parameter InteriorRegion of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class OutletRegion

Bases: PyTextual

Parameter OutletRegion of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Periodic1Region

Bases: PyTextual

Parameter Periodic1Region of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Periodic2Region

Bases: PyTextual

Parameter Periodic2Region of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShroudRegion

Bases: PyTextual

Parameter ShroudRegion of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SymmetryRegion

Bases: PyTextual

Parameter SymmetryRegion of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Tip1Region

Bases: PyTextual

Parameter Tip1Region of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Tip2Region

Bases: PyTextual

Parameter Tip2Region of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsSettings

Bases: PyMenu

Singleton GraphicsSettings.

Classes:

AutoDraw

Parameter AutoDraw of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AutoDraw

Bases: PyParameter

Parameter AutoDraw of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SaveCheckpointFiles

Bases: PyParameter

Parameter SaveCheckpointFiles of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None